home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / clipper / ks94an.zip / FIOCONV.HDR < prev    next >
Text File  |  1994-04-25  |  1KB  |  48 lines
  1. /******************************************************************************
  2.                  The Klipper Library, for CA-Clipper 5.x
  3.         Copyright (c), 1994, Wallace Information Systems Engineering
  4.  
  5. FUNCTION:
  6.  
  7. _FIO_Convert( cConvVal, cPassword ) --> cString
  8.  
  9. PARAMETERS:
  10.  
  11. cConvVal  : Value to convert
  12. cPassword : Encryption Password (Optional)
  13.  
  14. SHORT:
  15.  
  16. Decrypt a value encrypted by the _FIn() Function.
  17.  
  18. DESCRIPTION:
  19.  
  20. When _FIn() writes a database field with encryption, the _FOut() function can
  21. retrieve it when the field is read.  However, you may occasionally want to
  22. encrypt the value without actually writting it to the field in order to
  23. examine it first.
  24.  
  25. This is the purpose of _FIOConvert().  It will return the same encryption
  26. string that _FIn() will create, but without writting the database field.
  27.  
  28. If cPassword is not specified, then the character data passed is returned
  29. unchanged.
  30.  
  31. NOTE:
  32.  
  33. Note: There is no param checking done in this function.
  34.  
  35. You will cause a runtime error if you pass a non-character convert value.
  36. _FIn() and _FOut() check parameters for character values because they are
  37. called automatically in many cases, but YOU exercise all control of this
  38. func.
  39.  
  40. EXAMPLE:
  41.  
  42. _FIOConvert('THIS IS A TEST','PASSWORD')
  43.  
  44. Returns: an encrypted string if password is not blank (which in this case it
  45. isn't).
  46.  
  47. ******************************************************************************/
  48.